<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libBigWig: bwCommon.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libBigWig
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">bwCommon.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="bwCommon_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bwCommon_8h.html#a7dff7d19c1f094d5ff6a88553badffe0">bwSetPos</a>(<a class="code" href="structbigWigFile__t.html">bigWigFile_t</a> *fp, <span class="keywordtype">size_t</span> pos);</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keywordtype">size_t</span> <a class="code" href="bwCommon_8h.html#adc16c73076856035477e460ea4ea3d17">bwRead</a>(<span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> sz, <span class="keywordtype">size_t</span> nmemb, <a class="code" href="structbigWigFile__t.html">bigWigFile_t</a> *fp);</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keywordtype">long</span> <a class="code" href="bwCommon_8h.html#ab55fdfee13cf1d6f16440d8c6bc7a4fe">bwTell</a>(<a class="code" href="structbigWigFile__t.html">bigWigFile_t</a> *fp);</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<a class="code" href="structbwRTree__t.html">bwRTree_t</a> *<a class="code" href="bwCommon_8h.html#a1efdd9f510597b0a6ab449f33d4d0966">bwReadIndex</a>(<a class="code" href="structbigWigFile__t.html">bigWigFile_t</a> *fp, uint64_t offset);</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="keywordtype">void</span> <a class="code" href="bwCommon_8h.html#ac783a22d0eba14f369d7122c19b601ca">bwDestroyIndexNode</a>(<a class="code" href="structbwRTreeNode__t.html">bwRTreeNode_t</a> *node);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="keywordtype">void</span> <a class="code" href="bwCommon_8h.html#a28fafebf80e74cc1802bcc45d415560e">bwDestroyIndex</a>(<a class="code" href="structbwRTree__t.html">bwRTree_t</a> *idx);</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<a class="code" href="structbwOverlapBlock__t.html">bwOverlapBlock_t</a> *walkRTreeNodes(<a class="code" href="structbigWigFile__t.html">bigWigFile_t</a> *bw, <a class="code" href="structbwRTreeNode__t.html">bwRTreeNode_t</a> *root, uint32_t tid, uint32_t start, uint32_t end);</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keywordtype">void</span> destroyBWOverlapBlock(<a class="code" href="structbwOverlapBlock__t.html">bwOverlapBlock_t</a> *b);</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bwCommon_8h.html#a704e7ffb4907a0afcd63d8dbc73dea27">bwFinalize</a>(<a class="code" href="structbigWigFile__t.html">bigWigFile_t</a> *fp);</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructbwRTreeNode__t_html"><div class="ttname"><a href="structbwRTreeNode__t.html">bwRTreeNode_t</a></div><div class="ttdoc">A node within an R-tree holding the index for data.</div><div class="ttdef"><b>Definition:</b> bwValues.h:20</div></div>
<div class="ttc" id="abwCommon_8h_html_a28fafebf80e74cc1802bcc45d415560e"><div class="ttname"><a href="bwCommon_8h.html#a28fafebf80e74cc1802bcc45d415560e">bwDestroyIndex</a></div><div class="ttdeci">void bwDestroyIndex(bwRTree_t *idx)</div><div class="ttdoc">Frees space allocated by bwReadIndex There is generally little reason to use this,...</div><div class="ttdef"><b>Definition:</b> bwValues.c:784</div></div>
<div class="ttc" id="abwCommon_8h_html_a7dff7d19c1f094d5ff6a88553badffe0"><div class="ttname"><a href="bwCommon_8h.html#a7dff7d19c1f094d5ff6a88553badffe0">bwSetPos</a></div><div class="ttdeci">int bwSetPos(bigWigFile_t *fp, size_t pos)</div><div class="ttdoc">Like fsetpos, but for local or remote bigWig files. This will set the file position indicator to the ...</div><div class="ttdef"><b>Definition:</b> bwRead.c:19</div></div>
<div class="ttc" id="astructbwRTree__t_html"><div class="ttname"><a href="structbwRTree__t.html">bwRTree_t</a></div><div class="ttdef"><b>Definition:</b> bwValues.h:39</div></div>
<div class="ttc" id="abwCommon_8h_html_a1efdd9f510597b0a6ab449f33d4d0966"><div class="ttname"><a href="bwCommon_8h.html#a1efdd9f510597b0a6ab449f33d4d0966">bwReadIndex</a></div><div class="ttdeci">bwRTree_t * bwReadIndex(bigWigFile_t *fp, uint64_t offset)</div><div class="ttdoc">Reads a data index (either full data or a zoom level) from a bigWig file. There is little reason for ...</div><div class="ttdef"><b>Definition:</b> bwValues.c:791</div></div>
<div class="ttc" id="astructbwOverlapBlock__t_html"><div class="ttname"><a href="structbwOverlapBlock__t.html">bwOverlapBlock_t</a></div><div class="ttdoc">This structure holds the data blocks that overlap a given interval.</div><div class="ttdef"><b>Definition:</b> bwValues.h:56</div></div>
<div class="ttc" id="abwCommon_8h_html_ac783a22d0eba14f369d7122c19b601ca"><div class="ttname"><a href="bwCommon_8h.html#ac783a22d0eba14f369d7122c19b601ca">bwDestroyIndexNode</a></div><div class="ttdeci">void bwDestroyIndexNode(bwRTreeNode_t *node)</div><div class="ttdoc">Destroy an bwRTreeNode_t and all of its children.</div><div class="ttdef"><b>Definition:</b> bwValues.c:763</div></div>
<div class="ttc" id="abwCommon_8h_html_ab55fdfee13cf1d6f16440d8c6bc7a4fe"><div class="ttname"><a href="bwCommon_8h.html#ab55fdfee13cf1d6f16440d8c6bc7a4fe">bwTell</a></div><div class="ttdeci">long bwTell(bigWigFile_t *fp)</div><div class="ttdoc">Determine what the file position indicator say. This is equivalent to ftell for local or remote files...</div><div class="ttdef"><b>Definition:</b> bwRead.c:11</div></div>
<div class="ttc" id="abwCommon_8h_html_adc16c73076856035477e460ea4ea3d17"><div class="ttname"><a href="bwCommon_8h.html#adc16c73076856035477e460ea4ea3d17">bwRead</a></div><div class="ttdeci">size_t bwRead(void *data, size_t sz, size_t nmemb, bigWigFile_t *fp)</div><div class="ttdoc">A local/remote version of fread. Reads data from either local or remote bigWig files.</div><div class="ttdef"><b>Definition:</b> bwRead.c:26</div></div>
<div class="ttc" id="abwCommon_8h_html_a704e7ffb4907a0afcd63d8dbc73dea27"><div class="ttname"><a href="bwCommon_8h.html#a704e7ffb4907a0afcd63d8dbc73dea27">bwFinalize</a></div><div class="ttdeci">int bwFinalize(bigWigFile_t *fp)</div><div class="ttdoc">Finishes what's needed to write a bigWigFile Flushes the buffer, converts the index linked list to a ...</div><div class="ttdef"><b>Definition:</b> bwWrite.c:1229</div></div>
<div class="ttc" id="astructbigWigFile__t_html"><div class="ttname"><a href="structbigWigFile__t.html">bigWigFile_t</a></div><div class="ttdoc">A structure that holds everything needed to access a bigWig file.</div><div class="ttdef"><b>Definition:</b> bigWig.h:210</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 8 2020 13:48:36 for libBigWig by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
